conversations.remove()

Remove a Conversation from the roster.

The roster is represented as organization.conversations.

Definition

client.conversations.remove(
  conversationId: string|Conversation
):Promise<void,Error>

Parameters

NameTypeDescription
conversationIdstring|ConversationThe ID of the conversation

Returns

The function returns a Promise that resolves with a fully-loaded Conversation model.

Examples

await client.conversations.remove(
  'some-conversation-id'
);
console.log('conversation removed');