unlinkFromConversation

Omnichannel for Customer Service offers a suite of capabilities that extend the power of Dynamics 365 Customer Service Enterprise to enable organizations to instantly connect and engage with their customers across digital messaging channels. An additional license is required to access Omnichannel for Customer Service. For more information, see the Dynamics 365 Customer Service pricing overview and Dynamics 365 Customer Service pricing plan pages.

This function can be used to unlink an already linked entity record of type customer (account or contact) or case from a conversation.

Syntax

Microsoft.Omnichannel.unlinkFromConversation(entityLogicalName, recordId, conversationId);

Parameters

Parameter	Type	Description
entityLogicalName	String	Logical name of the entity (such as account, contact, or incident)
recordId	String	Unique identifier for the entity record to be unlinked
*conversationId	String	Unique identifier for the conversation to unlink. Also reffered to as liveworkitemId. Without providing this parameter, the entity will unlink from the focused conversation by default.

* Indicates optional parameter.

Return value

Returns a resolved or rejected promise based on the outcome of the operation.

Example

//Unlinking an already linked incident record from the current conversation 
Microsoft.Omnichannel.unlinkFromConversation("incident", "6b726d86-d37c-43b8-b3a4-c4056ddd2e07", "b7397aae-ecf8-43a6-aeb0-07d294efb494").then((response) => { 
    // Refreshing the tab UI  
    Microsoft.Apm.refreshTab("tab-id-3"); 
}, (error) => { 
    console.log(error); 
}); 

See also

Live chat SDK reference
Omnichannel JavaScript API reference
getConversations
getConversationId
linkToConversation
openConversation
sendMessageToConversation