WhatsApi icon

WhatsApi

Connect with WhatApp HTTP API

Overview

This node integrates with a WhatsApp HTTP API to update the description of a WhatsApp group. It is useful in scenarios where you want to programmatically change or set the description text of a specific group, for example, to provide updated information, announcements, or rules to group members without manual intervention.

Practical examples include:

  • Automatically updating group descriptions based on external events or data changes.
  • Managing multiple WhatsApp groups and keeping their descriptions consistent from a central system.
  • Using workflows to customize group info dynamically as part of customer engagement or community management.

Properties

Name Meaning
Phone The session ID representing the phone/account used to authenticate with the WhatsApp API. Typically linked to an API key or credential.
To The unique identifier (Jid) of the WhatsApp group whose description will be updated. Format example: [email protected].
Description The new description text to set for the specified WhatsApp group.

Output

The node outputs JSON data representing the response from the WhatsApp API after attempting to update the group description. This typically includes confirmation of success or details about any errors encountered.

If the API supports it, the output may also contain metadata about the updated group or status messages. There is no indication that binary data is involved in this operation.

Dependencies

  • Requires access to a WhatsApp HTTP API service endpoint.
  • Needs an API authentication token or session ID credential configured in n8n to authorize requests.
  • The base URL for the WhatsApp API must be set in the credentials.
  • The node sends JSON requests and expects JSON responses.

Troubleshooting

  • Invalid Session ID or Authentication Failure: Ensure the session ID (Phone property) is correct and the associated API credentials are valid and active.
  • Incorrect Group Jid: Verify the group Jid format and existence; an invalid or non-existent group ID will cause errors.
  • API Endpoint Issues: Confirm the WhatsApp API base URL is reachable and correctly configured.
  • Empty or Invalid Description: The description field must not be empty if required by the API; check input validation.
  • Error Responses from API: Review the JSON output for error messages returned by the API to diagnose issues such as permission problems or rate limits.

Links and References

Discussion