Baileys Instance icon

Baileys Instance

Use the wa-instance API built on Baileys 7

Group → Update Settings

AI-generated

Summary

Update one or more settings of a WhatsApp group specified by its Group JID.

Inputs

  • Group JID (required) — The unique identifier (JID) of the WhatsApp group to update.
  • Additional Options — Optional group settings to update, which include:
  • Setting: Change group mode such as Announcement, Locked, Unlocked, Not Announcement, or Default.
  • Join Approval Mode: Toggle whether joining the group requires approval (On, Off, or Default).
  • Member Add Mode: Control who can add members (Admin Only, All Members, or Default).

Output shape

a single record

Returns the updated group settings response from the backend API upon successful PATCH request. If no settings are provided, the operation will fail with an error indicating that at least one setting must be specified.

Examples

Example 1: Setting a group's announcement mode and join approval mode

Specify the Group JID and set Additional Options with Setting to 'announcement' and Join Approval Mode to 'on'. This changes the group to announcement mode and requires join approval.

Links

Discussion