Overview
This node integrates with the Vtiger CRM API, enabling users to perform various operations on Vtiger entities. Specifically, the Update operation allows updating an existing entity in Vtiger by its unique ID. It first retrieves the current entity data, merges it with the new data provided, and then sends an update request.
Common scenarios for this node include:
- Synchronizing updated customer or lead information from other systems into Vtiger.
- Automating updates to records based on workflow triggers.
- Modifying specific fields of an existing record without overwriting the entire entity.
For example, you might use this node to update a contact's phone number or address after receiving new information from a form submission.
Properties
| Name | Meaning |
|---|---|
| Entity ID | The unique identifier of the entity to update, formatted as MODULExID (e.g., "1x1234"). |
| Body | A JSON object containing the fields and their new values to update in the entity. |
Output
The node outputs a JSON array containing the response from the Vtiger API after the update operation. This response typically includes the updated entity data or confirmation of the update success.
No binary data output is produced by the Update operation.
Dependencies
- Requires connection credentials to a Vtiger CRM instance, including:
- Host URL of the Vtiger server.
- Username.
- An API access key for authentication.
- The node uses the Vtiger webservice API endpoints.
- Requires n8n HTTP Request helper functions to communicate with the API.
- Uses MD5 hashing for generating the access key signature during login.
Troubleshooting
Entity does not exist or error message on retrieval:
Before updating, the node attempts to retrieve the entity by its ID. If the entity is not found or the ID is invalid, the node throws an error indicating the entity does not exist.
Resolution: Verify that the Entity ID is correct and that the entity exists in Vtiger.Authentication errors:
If the initial challenge or login requests fail, the node will throw an error with the message returned by the Vtiger API.
Resolution: Check that the credentials (host, username, access key) are correct and that the Vtiger server is reachable.Invalid JSON in Body property:
The Body field must contain valid JSON representing the fields to update. Invalid JSON will cause parsing errors.
Resolution: Ensure the JSON structure is valid and properly formatted.API rate limits or connectivity issues:
Network problems or API limits may cause request failures.
Resolution: Check network connectivity and Vtiger API usage policies.