Z-API WhatsApp icon

Z-API WhatsApp

Integration with Z-API (WhatsApp) organized by resources (messages, groups, chats, contacts, products, queue, instance, status, etc.).

Group → Update Group Settings

AI-generated

Summary

Update group settings (e.g., admin permissions, message restrictions) for a WhatsApp group identified by its groupId.

Inputs

  • groupId (required) — WhatsApp group ID (e.g., 120363019502650977-group) identifying the group whose settings will be updated.
  • adminOnlyMessage — If true, only admins can send messages in the group after the update.
  • adminOnlySettings — If true, only admins can modify group settings such as description, photo, etc.
  • requireAdminApproval — If true, new participants must be approved by an admin before joining.
  • adminOnlyAddMember — If true, only admins can add new participants to the group.

Output shape

object

May contain a success indicator or the updated group metadata; errors are raised as exceptions.

Examples

Example 1: Enforce admin‑only messaging and member addition

groupId: 120363019502650977-group; adminOnlyMessage: true; adminOnlySettings: true; requireAdminApproval: true; adminOnlyAddMember: true

Example 2: Allow open messaging but restrict who can add participants

groupId: 120363019502650977-group; adminOnlyMessage: false; adminOnlySettings: true; requireAdminApproval: false; adminOnlyAddMember: true

Example 3: Disable admin approval for new members

groupId: 120363019502650977-group; adminOnlyMessage: true; adminOnlySettings: true; requireAdminApproval: false; adminOnlyAddMember: true

Links

Discussion