conversations.mute()

Mutes a Conversation.

When a conversation is muted, the current user won't receive push notifications on other devices.

Definition

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

Parameters

NameTypeDescription
conversationIdstring|ConversationA conversation ID
durationInMinutesnumberA positive integer between 1 and 525600 (1 year) which indicates how long the mute should last

Returns

The function returns a Promise that resolves when the operation is complete.

Examples

await client.conversations.mute(
  someConversation.id,
  10
);
console.log('conversation has been muted');