Overview
This node interacts with the SuiteCRM API to perform various operations on CRM modules, including deleting records. Specifically, the 'Delete' operation removes a record (bean) identified by its Bean ID from a specified module. This node is useful for automating CRM data management tasks such as cleaning up outdated or incorrect records. For example, it can be used to delete a contact or lead from the CRM system automatically based on certain workflow conditions.
Use Case Examples
- Deleting a contact record from the 'Contacts' module by specifying its Bean ID.
- Removing a lead from the 'Leads' module when it no longer qualifies for follow-up.
Properties
| Name | Meaning |
|---|---|
| Module | The CRM module on which to perform the delete operation. It can be selected from a list of available modules or specified as a custom module path. |
| Custom Module Path | The direct path of a custom module to perform the operation on, shown only if 'Custom' module is selected. |
| Description | An optional description for the node instance. |
| Bean ID | The unique identifier of the record (bean) to delete. This is required for the delete operation. |
Output
JSON
id- The ID of the deleted bean (record).type- The type of the deleted record, typically the module name.
Dependencies
- Requires an API key credential for SuiteCRM API authentication.
Troubleshooting
- Common issues include providing an invalid or missing Bean ID, which will cause the delete operation to fail with an error indicating the record was not found.
- If the module name or custom module path is incorrect, the API request will fail with a module not found or invalid endpoint error.
- Network or authentication errors may occur if the SuiteCRM API credentials are incorrect or expired. Verify the API key and connection settings.
Links
- SuiteCRM API Documentation - Official documentation for SuiteCRM API endpoints and usage.