Evolution API icon

Evolution API

Interact with Evolution API

Overview

The "Update Settings" operation for the Group resource in this node allows users to modify specific group settings related to messaging and editing permissions. This is useful in scenarios where group administrators want to control who can send messages or edit group settings, such as enforcing announcement-only modes or restricting setting changes to admins only.

Practical examples:

  • Setting a group so that only admins can send messages, turning it into an announcement channel.
  • Allowing all members to send messages freely.
  • Restricting group settings edits to admins only to prevent unauthorized changes.
  • Permitting everyone in the group to edit settings collaboratively.

Properties

Name Meaning
Instance Name The name of the instance where the group exists; used to identify the target environment.
Group ID The unique identifier of the group whose settings are to be updated.
Action The specific setting to apply to the group. Options:
- Only Admins Send Messages (announcement)
- Everyone Sends Messages (not_announcement)
- Only Admins Edit Settings (locked)
- Everyone Edits Settings (unlocked)

Output

The node outputs a JSON array containing the result of the update operation. The exact structure depends on the API response but typically includes confirmation of the applied setting or details about the updated group. There is no indication that binary data is output by this node.

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 API requests.
  • Proper configuration of the API authentication within n8n is necessary.

Troubleshooting

  • Operation not supported error: If the specified operation or resource is incorrect or unsupported, the node will throw an error indicating the function is not supported. Verify that the resource is "groups-api" and the operation is "update-settings".
  • Missing required parameters: Ensure that "Instance Name", "Group ID", and "Action" are provided; otherwise, the node may fail due to incomplete input.
  • API authentication errors: Confirm that the API key credential is correctly set up and has sufficient permissions.
  • Invalid group ID: Providing an incorrect or non-existent group ID may cause the API to return an error; verify the group ID before running the node.

Links and References

Discussion