doc publish

.lastupdated

@@ -1 +1 @@
-2025-01-18T07:32:19
+2025-01-23T07:55:55

docs/AgentAssistantsApi.md

@@ -675,4 +675,4 @@ apiInstance.putAssistantQueue(assistantId, queueId, body)
 **AssistantQueue**
 
 
-_purecloud-platform-client-v2@212.1.0_
+_purecloud-platform-client-v2@213.0.0_

docs/AgentCopilotApi.md

@@ -113,4 +113,4 @@ apiInstance.putAssistantCopilot(assistantId, body)
 **Copilot**
 
 
-_purecloud-platform-client-v2@212.1.0_
+_purecloud-platform-client-v2@213.0.0_

docs/AgentUIApi.md

@@ -217,4 +217,4 @@ apiInstance.putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body)
 **AutoAnswerSettings**
 
 
-_purecloud-platform-client-v2@212.1.0_
+_purecloud-platform-client-v2@213.0.0_

docs/AlertingApi.md

@@ -1318,4 +1318,4 @@ apiInstance.putAlertingRule(ruleId, body)
 **CommonRule**
 
 
-_purecloud-platform-client-v2@212.1.0_
+_purecloud-platform-client-v2@213.0.0_

docs/AnalyticsApi.md

@@ -2030,6 +2030,7 @@ let dashboardType = "dashboardType_example"; // String | List dashboard of given
 let dashboardAccessFilter = "dashboardAccessFilter_example"; // String | Filter dashboard based on the owner of dashboard
 let opts = { 
   'name': "name_example", // String | name of the dashboard
+  'dashboardState': "Active", // String | List dashboard of given state
   'sortBy': "desc", // String | 
   'pageNumber': 1, // Number | 
   'pageSize': 9 // Number | 
@@ -2050,9 +2051,10 @@ apiInstance.getAnalyticsReportingSettingsDashboardsQuery(dashboardType, dashboar
 
 | Name | Type | Description  | Notes |
 | ------------- | ------------- | ------------- | ------------- |
- **dashboardType** | **String** | List dashboard of given type | <br />**Values**: All, Public, Private, Shared, Favorites, Deleted |
+ **dashboardType** | **String** | List dashboard of given type | <br />**Values**: All, Public, Private, Shared, Favorites |
  **dashboardAccessFilter** | **String** | Filter dashboard based on the owner of dashboard | <br />**Values**: OwnedByMe, OwnedByAnyone, NotOwnedByMe |
  **name** | **String** | name of the dashboard | [optional]  |
+ **dashboardState** | **String** | List dashboard of given state | [optional] [default to Active]<br />**Values**: Active, Deleted |
  **sortBy** | **String** |  | [optional] [default to desc] |
  **pageNumber** | **Number** |  | [optional] [default to 1] |
  **pageSize** | **Number** |  | [optional] [default to 9] |
@@ -5654,4 +5656,4 @@ apiInstance.putAnalyticsDataretentionSettings(body)
 **AnalyticsDataRetentionResponse**
 
 
-_purecloud-platform-client-v2@212.1.0_
+_purecloud-platform-client-v2@213.0.0_

docs/ArchitectApi.md

@@ -8022,4 +8022,4 @@ apiInstance.putFlowsOutcome(flowOutcomeId, opts)
 **Operation**
 
 
-_purecloud-platform-client-v2@212.1.0_
+_purecloud-platform-client-v2@213.0.0_

docs/AuditApi.md

@@ -378,4 +378,4 @@ apiInstance.postAuditsQueryRealtimeRelated(body, opts)
 **AuditRealtimeRelatedResultsResponse**
 
 
-_purecloud-platform-client-v2@212.1.0_
+_purecloud-platform-client-v2@213.0.0_

docs/AuthorizationApi.md

@@ -2428,4 +2428,4 @@ apiInstance.putUserRoles(subjectId, body)
 **UserAuthorization**
 
 
-_purecloud-platform-client-v2@212.1.0_
+_purecloud-platform-client-v2@213.0.0_

docs/BillingApi.md

@@ -122,4 +122,4 @@ apiInstance.getBillingTrusteebillingoverviewTrustorOrgId(trustorOrgId, opts)
 **TrusteeBillingOverview**
 
 
-_purecloud-platform-client-v2@212.1.0_
+_purecloud-platform-client-v2@213.0.0_

docs/CarrierServicesApi.md

@@ -109,4 +109,4 @@ apiInstance.postCarrierservicesIntegrationsEmergencylocationsMe(opts)
 **EmergencyLocation**
 
 
-_purecloud-platform-client-v2@212.1.0_
+_purecloud-platform-client-v2@213.0.0_

docs/ChatApi.md

@@ -1731,4 +1731,4 @@ apiInstance.putChatsSettings(body)
 **ChatSettings**
 
 
-_purecloud-platform-client-v2@212.1.0_
+_purecloud-platform-client-v2@213.0.0_

docs/CoachingApi.md

@@ -1086,4 +1086,4 @@ apiInstance.postCoachingScheduleslotsQuery(body)
 **CoachingSlotsResponse**
 
 
-_purecloud-platform-client-v2@212.1.0_
+_purecloud-platform-client-v2@213.0.0_

docs/ContentManagementApi.md

@@ -1956,4 +1956,4 @@ apiInstance.putContentmanagementWorkspaceTagvalue(workspaceId, tagId, body)
 **TagValue**
 
 
-_purecloud-platform-client-v2@212.1.0_
+_purecloud-platform-client-v2@213.0.0_

docs/ConversationsApi.md

@@ -2389,11 +2389,16 @@ This endpoint does not need any parameter.
 
 > ChatConversation getConversationsChat(conversationId)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 GET /api/v2/conversations/chats/{conversationId}
 
 Get chat conversation
 
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
+
 Requires NO permissions:
 
 ### Example Usage
@@ -2437,12 +2442,15 @@ apiInstance.getConversationsChat(conversationId)
 
 > WebChatMessage getConversationsChatMessage(conversationId, messageId)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 GET /api/v2/conversations/chats/{conversationId}/messages/{messageId}
 
 Get a web chat conversation message
 
-The current user must be involved with the conversation to get its messages.
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages.
 
 Requires NO permissions:
 
@@ -2489,12 +2497,15 @@ apiInstance.getConversationsChatMessage(conversationId, messageId)
 
 > WebChatMessageEntityList getConversationsChatMessages(conversationId, opts)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 GET /api/v2/conversations/chats/{conversationId}/messages
 
 Get the messages of a chat conversation.
 
-The current user must be involved with the conversation to get its messages.
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages.
 
 Requires NO permissions:
 
@@ -2549,11 +2560,16 @@ apiInstance.getConversationsChatMessages(conversationId, opts)
 
 > AssignedWrapupCode getConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup
 
 Get the wrap-up for this conversation communication. 
 
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
+
 Requires NO permissions:
 
 ### Example Usage
@@ -2605,11 +2621,16 @@ apiInstance.getConversationsChatParticipantCommunicationWrapup(conversationId, p
 
 > AssignedWrapupCode getConversationsChatParticipantWrapup(conversationId, participantId, opts)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup
 
 Get the wrap-up for this conversation participant. 
 
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
+
 Requires NO permissions:
 
 ### Example Usage
@@ -2659,11 +2680,16 @@ apiInstance.getConversationsChatParticipantWrapup(conversationId, participantId,
 
 > [WrapupCode] getConversationsChatParticipantWrapupcodes(conversationId, participantId)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes
 
 Get list of wrapup codes for this conversation participant
 
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
+
 Requires NO permissions:
 
 ### Example Usage
@@ -2709,11 +2735,16 @@ apiInstance.getConversationsChatParticipantWrapupcodes(conversationId, participa
 
 > ChatConversationEntityListing getConversationsChats()
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 GET /api/v2/conversations/chats
 
 Get active chat conversations for the logged in user
 
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
+
 Requires NO permissions:
 
 ### Example Usage
@@ -6161,11 +6192,16 @@ apiInstance.patchConversationsCallbacks(body)
 
 > Conversation patchConversationsChat(conversationId, body)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 PATCH /api/v2/conversations/chats/{conversationId}
 
 Update a conversation by disconnecting all of the participants
 
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
+
 Requires ANY permissions:
 
 * conversation:communication:disconnect
@@ -6213,11 +6249,16 @@ apiInstance.patchConversationsChat(conversationId, body)
 
 > void patchConversationsChatParticipant(conversationId, participantId, body)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}
 
 Update conversation participant
 
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
+
 Requires ANY permissions:
 
 * conversation:participant:wrapup
@@ -6267,11 +6308,16 @@ void (no response body)
 
 > ParticipantAttributes patchConversationsChatParticipantAttributes(conversationId, participantId, body)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes
 
 Update the attributes on a conversation participant.
 
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
+
 Requires NO permissions:
 
 ### Example Usage
@@ -6319,11 +6365,16 @@ apiInstance.patchConversationsChatParticipantAttributes(conversationId, particip
 
 > **Object** patchConversationsChatParticipantCommunication(conversationId, participantId, communicationId, body)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}
 
 Update conversation participant's communication by disconnecting it.
 
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
+
 Requires NO permissions:
 
 ### Example Usage
@@ -9538,11 +9589,16 @@ apiInstance.postConversationsCalls(body)
 
 > WebChatMessage postConversationsChatCommunicationMessages(conversationId, communicationId, body)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages
 
 Send a message on behalf of a communication in a chat conversation.
 
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
+
 Requires NO permissions:
 
 ### Example Usage
@@ -9590,11 +9646,16 @@ apiInstance.postConversationsChatCommunicationMessages(conversationId, communica
 
 > WebChatTyping postConversationsChatCommunicationTyping(conversationId, communicationId)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing
 
 Send a typing-indicator on behalf of a communication in a chat conversation.
 
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
+
 Requires NO permissions:
 
 ### Example Usage
@@ -9640,11 +9701,16 @@ apiInstance.postConversationsChatCommunicationTyping(conversationId, communicati
 
 > void postConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 POST /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup
 
 Apply wrap-up for this conversation communication
 
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
+
 Requires ANY permissions:
 
 * conversation:participant:wrapup
@@ -9698,11 +9764,16 @@ void (no response body)
 
 > void postConversationsChatParticipantReplace(conversationId, participantId, body)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 POST /api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace
 
 Replace this participant with the specified user and/or address
 
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
+
 Requires ANY permissions:
 
 * conversation:communication:blindTransfer
@@ -9752,11 +9823,16 @@ void (no response body)
 
 > ChatConversation postConversationsChats(body)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 POST /api/v2/conversations/chats
 
 Create a web chat conversation
 
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
+
 Requires ALL permissions:
 
 * conversation:webchat:create
@@ -12167,11 +12243,16 @@ apiInstance.putConversationsCallbackRecordingstate(conversationId, body)
 
 > **'String'** putConversationsChatRecordingstate(conversationId, body)
 
+:::{"alert":"warning","title":"Deprecated","collapsible":false,"autoCollapse":false}
+This resource has been deprecated
+:::
 
 PUT /api/v2/conversations/chats/{conversationId}/recordingstate
 
 Update a conversation by setting its recording state
 
+This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
+
 Requires ANY permissions:
 
 * conversation:recording:pauseOthers
@@ -12790,4 +12871,4 @@ apiInstance.putConversationsVideoRecordingstate(conversationId, body)
 **'String'**
 
 
-_purecloud-platform-client-v2@212.1.0_
+_purecloud-platform-client-v2@213.0.0_