Overview
This node integrates with the Vtiger CRM API, enabling users to perform various operations on Vtiger entities. Specifically, the Delete operation allows users to remove an entity from the Vtiger system by specifying its unique Entity ID.
Common scenarios for using this node include automating CRM data management tasks such as deleting outdated or incorrect records, cleaning up test data, or removing related entities as part of a workflow.
For example, if a sales lead is no longer valid, you can use this node to delete that lead automatically based on its ID, helping maintain clean and accurate CRM data.
Properties
| Name | Meaning |
|---|---|
| Entity ID | The unique identifier of the entity to delete, formatted as MODULExID (e.g., "1x1234"). |
Output
The output is a JSON array containing the response from the Vtiger API after attempting to delete the specified entity. This typically includes a success flag and any relevant messages or error details returned by the API.
Example output structure:
[
{
"success": true,
"result": { /* details about the deleted entity or confirmation */ }
}
]
No binary data is produced by this operation.
Dependencies
- Requires connection to a Vtiger CRM instance.
- Needs an API authentication credential (an API key and username) configured in n8n to authenticate requests.
- The node uses HTTP requests to communicate with the Vtiger webservice endpoint (
/webservice.php).
Troubleshooting
- Authentication errors: If the node fails to authenticate, verify that the API credentials (username and access key) are correct and have sufficient permissions.
- Entity not found: If the specified Entity ID does not exist, the API will return an error. Double-check the format and correctness of the Entity ID.
- Network issues: Ensure the Vtiger host URL is reachable from the n8n environment.
- API limits or restrictions: If the API returns rate limit errors or permission denied messages, check the Vtiger server settings and user roles.
Common error message example:
"Entity does not exists or <error message>"— indicates the entity ID provided was invalid or the entity has already been deleted.
Resolving these usually involves verifying input parameters and credentials.
Links and References
- Vtiger CRM Webservice API Documentation
- n8n HTTP Request Node Documentation (for understanding underlying HTTP calls)