Overview
This node integrates with the Vtiger CRM API, enabling users to perform various operations on Vtiger modules such as creating, updating, deleting records, querying data, and managing relationships between entities. Specifically, the "Create" operation allows users to add new records to a specified module by providing the module name and the record data in JSON format.
Common scenarios where this node is beneficial include:
- Automating the creation of leads, contacts, or other CRM entities from external data sources.
- Integrating Vtiger CRM with other systems to synchronize customer or sales data.
- Quickly adding new records during workflow automation without manual entry.
Example: Automatically create a new Lead in Vtiger when a form is submitted on a website by specifying the "Leads" module and passing the lead details as JSON.
Properties
| Name | Meaning |
|---|---|
| Module | Exact module name in Vtiger (case sensitive) where the new record will be created. |
| Body | JSON structure containing fieldname:value pairs representing the data for the new record. |
Output
The output is a JSON array containing the response from the Vtiger API after attempting to create the record. This typically includes information about the newly created entity, such as its ID and any metadata returned by the API.
No binary data output is produced by the "Create" operation.
Dependencies
- Requires an active connection to a Vtiger CRM instance via an API key credential.
- The node performs authentication by requesting a challenge token and then logging in using the provided credentials.
- The Vtiger API endpoint URL and user credentials must be configured in the node's credentials settings.
Troubleshooting
- Authentication errors: If the node fails at the login step, verify that the API host URL, username, and access key are correct and that the Vtiger instance is reachable.
- Invalid module name: Providing an incorrect or misspelled module name will cause the API to reject the request. Ensure the module name matches exactly, including case sensitivity.
- Malformed JSON body: The "Body" property must contain valid JSON with appropriate fields for the target module. Invalid JSON or missing required fields may result in API errors.
- API errors: The node throws errors with messages returned by the Vtiger API. Review these messages to identify issues such as permission problems or invalid data.