Overview
This node integrates with the SuiteCRM API to perform various operations on CRM modules. Specifically, the 'Link' operation allows users to link a related bean (record) from one module to another via a specified relationship. This is useful for associating related data entities within SuiteCRM, such as linking a contact to an account or associating a product with an opportunity. Practical examples include linking a customer record to a sales order or associating a support case with a contact.
Use Case Examples
- Linking a contact record to an account to establish a relationship between the two entities.
- Associating a product with an opportunity to track which products are involved in a sales deal.
Properties
| Name | Meaning |
|---|---|
| Module | The SuiteCRM module on which to perform the operation, e.g., Accounts, Contacts, or a custom module. |
| Custom Module Path | Direct path to a custom module, used only if 'Custom' module is selected. |
| Description | Optional description for the node instance. |
| Bean ID | The unique identifier of the bean (record) in the selected module to link from. |
| Relationship Name | The name of the relationship to fetch or link, defining how the two beans are related. |
| Related Bean Module | The module of the related bean (record) to link to. |
| Related Bean ID | The unique identifier of the related bean (record) to link to the original bean. |
Output
JSON
id- The ID of the linked bean or the result of the link operation.type- The type of the linked bean or resource.attributes- Attributes of the linked bean or the response data from the link operation.
Dependencies
- SuiteCRM API
- API authentication token or API key credential
Troubleshooting
- Common issues include invalid or missing bean IDs, incorrect relationship names, or insufficient permissions to link records in SuiteCRM.
- Error messages may indicate failed API requests due to incorrect module names, invalid relationship names, or network issues. Verify all input parameters and ensure the API credentials have appropriate access rights.
Links
- SuiteCRM API Documentation - Official documentation for SuiteCRM API endpoints and usage.