@wppconnect/wa-js - v3.19.3
    Preparing search index...

    Function pinMsg

    • Pin a message in chat

      Parameters

      • msgId: string | MsgKey

        Message ID to pin/unpin

      • pin: boolean = true

        True to pin, false to unpin

      • duration: number | PinExpiryDurationOption = PinExpiryDurationOption.SevenDays

        Pin duration option. Use PinExpiryDurationOption enum for precise control.

      Returns Promise<{ message: MsgModel; pinned: boolean; result: SendMsgResult }>

      3.18.9 - BREAKING CHANGE: The seconds parameter (number) has been replaced with PinExpiryDurationOption enum. For backward compatibility, numbers are still accepted but will ALWAYS default to 7 days, regardless of the value passed. Use PinExpiryDurationOption enum for precise duration control.

      // Pin a message in chat with default duration (7 days)
      WPP.chat.pinMsg('true_[number]@c.us_ABCDEF');

      // Pin a message in chat for 30 days (RECOMMENDED)
      WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', true, WPP.whatsapp.PinExpiryDurationOption.ThirtyDays);

      // Pin a message in chat for 1 day
      WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', true, WPP.whatsapp.PinExpiryDurationOption.OneDay);

      // DEPRECATED: Passing numbers (always results in 7 days)
      WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', true, 2592000); // Ignored, defaults to 7 days

      // Unpin a message
      WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', false);
      // or
      WPP.chat.unpinMsg('true_[number]@c.us_ABCDEF');

    Settings

    Member Visibility