Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node "Evolution API" allows interaction with the Evolution API service. Specifically, for the Resource "Group" and Operation "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 dynamically, such as updating team information, project details, or announcements in group chats.

Practical example:

  • Automatically update the description of a project group when the project status changes.
  • Change group descriptions to reflect new guidelines or contact information without manual intervention.

Properties

Name Meaning
Name Da Instância The name of the instance where the group description will be updated.
Group ID 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 description. The structure typically includes confirmation of the update or details about the updated group. No binary data output is indicated.

Example output (conceptual):

[
  {
    "groupJid": "string",
    "description": "string",
    "status": "success"
  }
]

Dependencies

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

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 errors: Ensure the API key credential is valid and has the necessary permissions.
  • Invalid Group ID: Confirm that the provided Group ID exists and is correctly formatted.
  • Empty or invalid description: The new description must be a non-empty string; otherwise, the API may reject the request.

Links and References

Discussion