SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

Overview

The "Update Group" operation in the Groups resource allows users to modify the settings of an existing WhatsApp group associated with a specific WhatsApp number. This includes changing the group's name, description, permissions for participants, and ephemeral message settings.

This node is beneficial when managing WhatsApp groups programmatically, such as updating group details after creation, adjusting participant permissions dynamically, or enabling/disabling ephemeral messages for privacy or compliance reasons.

Practical examples:

  • Renaming a customer support group to reflect a new campaign.
  • Changing who can send messages or invite participants to control group activity.
  • Setting ephemeral messages to automatically delete after a certain period to maintain confidentiality.

Properties

Name Meaning
WhatsApp Number The ID of the WhatsApp number (device) through which the group is managed. This selects the WhatsApp account used for the operation.
Group ID The unique identifier of the WhatsApp group to update (e.g., 447362053576-1500000000 or 447362053576-1500000000@g.us).
Group Name The new name to assign to the group.
Description Optional. A textual description of the group, up to 500 characters.
Group Permissions Collection of permission settings controlling group behavior:
β€’ Edit Settings Permission: Who can edit group settings (All Participants or Admins Only).
β€’ Send Messages Permission: Who can send messages.
β€’ Invite Permission: Who can invite new participants.
β€’ Require Approval: Boolean indicating if new participants require admin approval before joining.
Ephemeral Messages Optional. Controls automatic deletion of messages in the group. Options are:
β€’ Off
β€’ 24 Hours
β€’ 7 Days
β€’ 90 Days

Output

The node outputs JSON data representing the updated group information returned by the API after the update operation. This typically includes confirmation of the new group name, description, permissions, and ephemeral message settings.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the SparkBot WhatsApp API service.
  • The node depends on the availability of the WhatsApp number (device) and the group ID being valid and accessible via the authenticated account.
  • Proper configuration of the n8n credentials with the required API key is necessary.

Troubleshooting

  • Invalid Group ID: If the provided group ID does not exist or is not associated with the selected WhatsApp number, the API will likely return an error. Verify that the group ID is correct and belongs to the specified device.
  • Permission Errors: Attempting to update group settings without sufficient permissions may cause failures. Ensure the API key has rights to manage groups.
  • Invalid Property Values: Providing invalid values for permissions or ephemeral message settings may result in errors. Use only the allowed options as specified.
  • API Key Issues: Authentication failures due to missing or incorrect API keys will prevent the operation from succeeding. Confirm the API key is correctly set in n8n credentials.
  • Network or Service Downtime: Temporary connectivity issues or API downtime can cause errors; retrying later might resolve these.

Links and References

Discussion