Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node, named "Evolution API," allows users to interact with the Evolution API service. Specifically, for the resource "Grupo" and operation "Atualizar Descrição Do Grupo" (Update Group Description), it updates the description of a specified group within an instance. This is useful in scenarios where group metadata needs to be kept current or modified programmatically, such as updating team information or clarifying group purposes.

Practical examples include:

  • Automatically updating group descriptions based on project status changes.
  • Synchronizing group descriptions with external systems or databases.
  • Managing multiple groups' metadata efficiently without manual intervention.

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 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 response from the Evolution API after attempting to update the group's description. The exact structure depends on the API's response but typically includes confirmation of the update or details about the updated group.

If the API supports binary data output, it would be summarized here; however, based on the provided code and properties, the output is purely JSON.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node uses the base URL https://doc.evolution-api.com/api-reference for requests.
  • Proper configuration of the API authentication credentials in n8n is necessary.

Troubleshooting

  • Unsupported Operation Error: If the operation or resource is not supported, the node throws an error stating the function is not supported. Ensure the correct resource ("groups-api") and operation ("update-group-description") are selected.
  • Missing Required Properties: All three input properties are required. Missing any will likely cause the node to fail or the API to reject the request.
  • API Authentication Issues: Invalid or missing API credentials will prevent successful communication with the Evolution API.
  • Invalid Group ID or Instance Name: Providing incorrect identifiers may result in errors or no changes applied.

To resolve these issues:

  • Double-check property values for correctness.
  • Verify API credentials and permissions.
  • Consult API documentation for valid group IDs and instance names.

Links and References

Discussion