Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node named "Evolution API" allows users to interact with the Evolution API service. Specifically, for the Resource "Profile" and Operation "Update Profile Name," it enables updating the name of a user profile on the specified instance. This is useful in scenarios where you need to programmatically rename profiles within an application or system managed by the Evolution API.

Practical examples include:

  • Renaming a user profile after a change in user details.
  • Automating profile updates as part of a larger workflow that manages user data.
  • Synchronizing profile names from external systems into the Evolution API-managed environment.

Properties

Name Meaning
Instance Name The name of the instance where the profile exists; required to identify the target environment.
Name The new profile name to update to; this is the updated value for the profile's name field.

Output

The node outputs a JSON array containing the result of the update operation. Each item in the output corresponds to the response from the Evolution API after attempting to update the profile name. The exact structure depends on the API response but generally includes confirmation of the update or details about the updated profile.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The base URL for requests is set to https://doc.evolution-api.com/api-reference.
  • The node expects JSON content-type headers for communication.
  • Proper configuration of the API authentication credentials in n8n is necessary.

Troubleshooting

  • Unsupported operation error: If the node throws an error stating the operation is unsupported, verify that the resource and operation names are correctly set to "profile-api" and "update-profile-name" respectively.
  • Authentication errors: Ensure the API key or authentication token is valid and has sufficient permissions to update profile information.
  • Missing required properties: Both "Instance Name" and "Name" must be provided; missing these will cause the node to fail.
  • API connectivity issues: Network problems or incorrect base URL settings can prevent successful API calls.

Links and References

Discussion