Overview
This node integrates with the SuiteCRM API to perform various operations on CRM modules. It supports operations such as retrieving, creating, updating, linking, and deleting records within specified modules. Users can specify the module, operation type, and relevant parameters like bean ID and fields to customize the API requests. This node is useful for automating CRM data management tasks, such as updating customer information, retrieving related records, or managing relationships between entities in SuiteCRM.
Use Case Examples
- Updating a contact's information by specifying the contact's bean ID and the fields to update.
- Retrieving a list of records from a specific module with filtering options.
- Linking two records in different modules to establish a relationship.
Properties
| Name | Meaning |
|---|---|
| Module | The SuiteCRM module on which to perform the operation. Users can select from available modules or specify a custom module path if 'Custom' is chosen. |
| Custom Module Path | Directly specify the path of a custom module when the 'Custom' module option is selected. |
| Description | A description for the node instance, useful for documentation or identification within workflows. |
| Bean ID | The unique identifier of the record (bean) to operate on. Required for operations like update, getRelationship, link, and delete. |
| Fields | A collection of fields and their values to be used as query parameters or data attributes for operations like get, create, and update. Includes field name, operator (for filtering), and value. |
| Custom Fields | Similar to Fields but used when working with custom modules. Allows specifying field name, operator, and value for filtering or data attributes. |
Output
JSON
data- The main data returned from the SuiteCRM API, which can be a single record or an array of records depending on the operation.
Dependencies
- SuiteCRM API
Troubleshooting
- Ensure the SuiteCRM API credentials are correctly configured and tested before using the node.
- Verify that the bean ID provided exists in the specified module to avoid errors during update or delete operations.
- Check that the module name and field names are valid and supported by the SuiteCRM instance.
- If using custom modules or fields, ensure the paths and names are correctly specified to prevent request failures.
Links
- SuiteCRM Documentation - Official documentation for SuiteCRM, useful for understanding modules, fields, and API usage.