Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node interacts with the Evolution API to perform various operations on different resources. Specifically, for the "Grupo" resource and the "Atualizar Descrição Do Grupo" operation, it updates the description of a specified group within an instance. This is useful in scenarios where group metadata needs to be kept current, such as updating group information in messaging or collaboration platforms.

Practical examples include:

  • Automatically updating group descriptions based on external data changes.
  • Managing group metadata programmatically during workflows.
  • Synchronizing group details across multiple systems.

Properties

Name Meaning
Nome Da Instância The name of the instance where the group description will be updated.
ID Do Grupo The unique identifier (JID) of the group whose description is to be updated.
Nova Descrição The new description text that will be set for the specified group.

Output

The node outputs a JSON array containing the result of the update operation. Typically, this will include confirmation details such as success status or updated group information returned by the Evolution API.

If the API supports returning binary data related to the group or update process, it would be included accordingly, but based on the provided code and properties, the output focuses on JSON data representing the update response.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects proper configuration of this credential within n8n.
  • Network access to the Evolution API endpoint is necessary.

Troubleshooting

  • Operation Not Supported Error: If you receive an error stating the operation is not supported, verify that the resource and operation names are correctly set to "groups-api" and "update-group-description" respectively.
  • Authentication Failures: Ensure the API key credential is valid and has sufficient permissions to update group descriptions.
  • Invalid Group ID: Confirm that the "ID Do Grupo" corresponds to an existing group in the specified instance.
  • Empty or Invalid Description: The "Nova Descrição" must be a non-empty string; otherwise, the API may reject the request.

Links and References

  • Evolution API official documentation (please refer to your internal or public API docs for detailed endpoints and payloads).
  • n8n documentation on creating and using API credentials.
  • General best practices for managing group metadata in collaboration platforms.

Discussion