Overview
This node integrates with the Vtiger CRM API, enabling users to perform various operations on Vtiger entities. Specifically, the "Create Relation" operation allows you to establish a relationship between two existing entities in Vtiger by specifying their IDs and the type of relation.
Common scenarios for this operation include linking related records such as associating a contact with an account, connecting a product to a sales order, or any custom relationship defined in Vtiger. This is useful for maintaining data integrity and reflecting real-world relationships within your CRM data.
Example: You have a Lead record (Entity ID) and want to relate it to a Campaign record (Related Entity ID) using a specific relation label like "Campaigns". This node operation will create that link in Vtiger.
Properties
| Name | Meaning |
|---|---|
| Entity ID | The unique identifier of the primary entity formatted as MODULExID (e.g., "1x1234"). |
| Related Entity ID | The unique identifier of the related entity formatted as MODULExID (e.g., "1x5678"). |
| Relation Label | The exact name of the relation label defining the relationship type (case sensitive). |
Output
The output is a JSON object representing the response from the Vtiger API after attempting to create the relation. It typically contains success status and details about the created relation or error information if the operation failed.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to a Vtiger CRM instance.
- Needs credentials including the host URL, username, and an API access key for authentication.
- The node performs HTTP requests to the Vtiger webservice endpoint
/webservice.php. - Authentication involves obtaining a challenge token and then logging in with a hashed access key.
Troubleshooting
- Authentication errors: If login fails, verify the correctness of the username, host URL, and API access key.
- Invalid Entity IDs: Ensure that both the Entity ID and Related Entity ID are correctly formatted as MODULExID and exist in Vtiger.
- Incorrect Relation Label: The relation label must exactly match the label defined in Vtiger, including case sensitivity.
- API Errors: The node throws errors with messages returned by the Vtiger API; check these messages for clues.
- Network issues: Confirm that the Vtiger server is reachable from n8n and no firewall blocks the requests.