Overview
This node updates the description of a specified group using a Chat API. It is useful in scenarios where you want to programmatically change or manage group descriptions, such as updating team info, event details, or announcements within a chat group. For example, a marketing team could automatically update a campaign group's description to reflect current promotions.
Properties
| Name | Meaning |
|---|---|
| Group ID | The unique identifier of the group whose description will be updated. |
| New Description | The new text that will replace the current description of the group. |
Output
The node outputs a JSON object containing the response data from the Chat API after attempting to update the group description. This typically includes confirmation of the update or any relevant metadata returned by the API.
Dependencies
- Requires an API key credential for authenticating with the Chat API.
- Needs the base URL and session token configured via credentials.
- Uses the
axioslibrary to make HTTP POST requests to the Chat API endpoint/v1/updateGroupDescription.
Troubleshooting
Common issues:
- Invalid or expired API token may cause authentication failures.
- Incorrect Group ID format or non-existent group can lead to errors from the API.
- Network connectivity problems might prevent successful API calls.
Error messages:
- Authentication errors usually indicate invalid credentials; verify and update the API key/token.
- API response errors related to group ID suggest checking the correctness of the provided group identifier.
- If the node throws an error with item index information, it indicates which input item caused the failure, helping isolate problematic inputs.
Links and References
- Refer to your Chat API documentation for details on the
/v1/updateGroupDescriptionendpoint and required request structure. - Axios HTTP client documentation: https://axios-http.com/