WAREST icon

WAREST

Interact with the WARest WhatsApp REST API

Overview

This node operation toggles the announcement mode of a WhatsApp group via the WARest WhatsApp REST API. Announcement mode restricts message sending in the group to admins only, which is useful for managing group communication and preventing non-admin members from sending messages. For example, a group admin can enable announcement mode to broadcast important updates without interruptions from other members.

Use Case Examples

  1. Enable announcement mode in a group to allow only admins to send messages.
  2. Disable announcement mode to allow all group members to send messages.

Properties

Name Meaning
Session The WhatsApp session identifier used to authenticate and perform the operation.
Group ID The unique identifier (JID) of the WhatsApp group where announcement mode will be toggled.
Announcement Mode Boolean flag to enable (true) or disable (false) announcement mode, restricting message sending to admins only.

Output

JSON

  • json - The response from the WARest API indicating the result of toggling the announcement mode, typically including success status and updated group information.

Dependencies

  • Requires an API key credential for the WARest WhatsApp REST API and the base URL of the API server.

Troubleshooting

  • Ensure the session ID is valid and active; invalid sessions will cause authentication errors.
  • Verify the group ID is correct and corresponds to an existing WhatsApp group.
  • The API key credential must be correctly configured and have permissions to modify group settings.
  • If the announcement mode toggle fails, check network connectivity and API server availability.
  • Error messages from the API will be propagated; review them to understand issues such as permission denied or invalid parameters.

Links

Discussion