Overview
This node integrates with the SuiteCRM API to perform various operations on CRM modules, including fetching relationships between data entities. It is useful for automating CRM data retrieval and management tasks, such as getting related records for a specific CRM bean (record). For example, it can fetch all related contacts for an account or retrieve linked opportunities for a lead.
Use Case Examples
- Fetch related contacts for a given account by specifying the account's Bean ID and the relationship name 'contacts'.
- Retrieve linked opportunities for a lead by providing the lead's Bean ID and the relationship name 'opportunities'.
Properties
| Name | Meaning |
|---|---|
| Module | The CRM module on which to perform the operation, e.g., Accounts, Contacts, or a custom module. |
| Custom Module Path | Directly specify the path of a custom module when 'Custom' is selected as the module. |
| Description | Optional description for the node instance. |
| Bean ID | The unique identifier of the CRM record (bean) to operate on. Required for operations involving specific records. |
| Relationship Name | The name of the relationship to fetch or link, such as 'contacts' or 'opportunities'. Required for relationship operations. |
Output
JSON
*- The JSON output contains the data returned from the SuiteCRM API, typically the related records or the requested module data.
Dependencies
- SuiteCRM API
- An API key credential for SuiteCRM authentication
Troubleshooting
- Common issues include invalid or missing Bean ID, incorrect relationship names, or API authentication failures.
- Error messages may indicate missing required parameters or API request failures; ensure all required fields are correctly set and the API credentials are valid.
Links
- SuiteCRM Documentation - Official documentation for SuiteCRM API and usage.