WapiZap Group icon

WapiZap Group

Manage WhatsApp groups via WapiZap API

Update Settings

AI-generated

Summary

Updates a WhatsApp group's settings (subject, description, announcement‑only mode, and lock) via the WapiZap API.

Inputs

  • instanceName (required) — Name of the WhatsApp instance to target.
  • groupId (required) — WhatsApp group ID (e.g., 120363012345678901@g.us).
  • apiVersion — API version to use: 'v2' (default) or 'v1'.
  • settings.subject — New group name/subject.
  • settings.description — New group description.
  • settings.announcement — When true, only admins can send messages.
  • settings.locked — When true, only admins can edit group info.

Output shape

object

Contains the response from the WapiZap API after applying the requested settings updates (typically the updated group object or a success payload).

Examples

Example 1: Rename a group and make it announcement‑only

Set instanceName, groupId, and under Settings provide subject and announcement = true.

Discussion