Z-API WhatsApp icon

Z-API WhatsApp

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

Actions51

Group → Update Group Description

AI-generated

Summary

Update the description of a WhatsApp group.

Inputs

  • groupId (required) — Group ID (Group ID/phone). Example: 120363019502650977-group. Use the group metadata/list groups API to get this value.
  • groupDescription — Group description to be updated

Output shape

object representing the API response (success confirmation or error details)

Response may include any fields defined by the Z-API; typically contains a status or confirmation message. No guaranteed structure beyond being a JSON object.

Examples

Example 1: Change the group description of an existing group

Set resource to "groups", operation to "updateGroupDescription", provide groupId and groupDescription values

Example 2: Update description of a group named "Community Garden"

Supply the group's ID in groupId and the new text in groupDescription; the node will POST to /update-group-description

Links

Discussion