Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node interacts with the Evolution API to update settings of a specified group. It allows users to modify group configurations such as message sending permissions and settings editing rights. This is useful for managing group communication policies in applications that integrate with the Evolution API, for example, setting a group to allow only admins to send messages or to lock the group settings so only admins can edit them.

Use Case Examples

  1. Updating a group to allow only admins to send messages (announcement mode).
  2. Changing a group setting to allow everyone to send messages (not announcement mode).
  3. Locking group settings so only admins can edit them.
  4. Unlocking group settings to allow everyone to edit them.

Properties

Name Meaning
Instance Name The name of the instance where the group exists, used to identify the target environment for the update.
Group ID The unique identifier of the group whose settings are to be updated.
Action The specific setting to apply to the group, such as message sending permissions or settings editing rights.

Output

JSON

  • response - The JSON response from the Evolution API after updating the group settings, typically containing status and updated group information.

Dependencies

  • Requires an API key credential for the Evolution API to authenticate requests.

Troubleshooting

  • Ensure the provided Group ID is correct and exists in the specified instance to avoid errors.
  • Verify that the API key credential is valid and has the necessary permissions to update group settings.
  • If the operation is unsupported or the function for the resource is missing, check that the node version supports the 'update-settings' operation for the 'Group' resource.

Links

  • Evolution API Documentation - Official documentation for the Evolution API, useful for understanding available endpoints and request formats.

Discussion