Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node named "Evolution API" allows interaction with the Evolution API service. Specifically, for the Resource "Profile" and Operation "Update Status," it updates a user's profile status on the specified instance of the Evolution API. This is useful in scenarios where you want to programmatically change or set a profile's status message, such as updating availability, mood, or any custom status text.

Practical examples include:

  • Automatically setting a user's status based on calendar events (e.g., "In a meeting").
  • Updating status messages in bulk for multiple profiles.
  • Integrating status updates into workflows triggered by external events or systems.

Properties

Name Meaning
Instance Name The name of the Evolution API instance where the profile status will be updated.
Status The new profile status message to set. It must be a string with a maximum length of 139 characters.

Output

The node outputs a JSON array containing the result of the status update operation. The exact structure depends on the Evolution API response but generally includes confirmation of the updated status or relevant metadata about the profile after the update.

If the API supports binary data output, it is not indicated in the provided code or properties, so the output is expected to be purely JSON.

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.
  • The node expects the Evolution API to be accessible and properly configured with the provided instance name and credentials.

Troubleshooting

  • Operation not supported error: If the node throws an error stating that the operation is not supported, verify that the resource and operation names are correctly set to "profile" and "update-status" respectively.
  • Invalid or missing credentials: Ensure that a valid API authentication token or key is configured in the node credentials.
  • Status length exceeded: The status property has a maximum length of 139 characters; exceeding this limit may cause errors.
  • Instance name issues: Providing an incorrect or non-existent instance name will likely cause the API call to fail. Double-check the instance name spelling and availability.
  • Network or API errors: Check network connectivity and API endpoint availability if requests fail unexpectedly.

Links and References

Discussion