Overview
This node provides generic operations to interact with any module in a SuiteCRM instance via its API. It supports common CRUD (Create, Read, Update, Delete) actions and relationship retrieval for SuiteCRM modules.
The Update operation specifically allows updating an existing record in a selected SuiteCRM module by specifying the record ID and the fields to update as JSON data.
Common scenarios:
- Synchronizing data from other systems into SuiteCRM by updating existing records.
- Automating updates to customer or sales data based on external triggers.
- Modifying SuiteCRM records programmatically without manual UI interaction.
Example:
You have a contact record in SuiteCRM that needs to be updated with new phone number and address information received from another system. Using this node's Update operation, you specify the "Contacts" module, provide the record ID, and pass the updated fields as JSON to update the record seamlessly.
Properties
| Name | Meaning |
|---|---|
| Module | Select the SuiteCRM module to operate on (e.g., Contacts, Accounts). |
| Record ID | The unique identifier of the record within the selected module to update. |
| Data (JSON) | JSON object containing the fields and their new values to update in the specified record. |
Output
The output is a JSON object representing the updated record returned by the SuiteCRM API. It typically contains:
data: An object with:type: The module name.id: The record ID.attributes: The updated fields and their values.
If the update is successful, the node outputs the updated record data as received from SuiteCRM.
No binary data output is produced by this operation.
Dependencies
- Requires valid credentials for authenticating with the SuiteCRM API (an API key or OAuth token).
- Needs the SuiteCRM API URL and access token, which are obtained during authentication.
- The node uses HTTP requests to communicate with the SuiteCRM REST API endpoints.
Troubleshooting
- Invalid Record ID: If the provided record ID does not exist in the selected module, the API will return an error. Verify the ID is correct.
- Malformed JSON Data: The "Data (JSON)" property must be valid JSON. Invalid JSON will cause parsing errors.
- Authentication Errors: Ensure the API credentials are valid and have sufficient permissions to update records.
- Module Not Found: Selecting a module that does not exist or is misspelled will cause failures. Use the module dropdown to avoid typos.
- API Endpoint Issues: Network issues or incorrect API URL configuration can cause request failures.
Error messages from the API usually indicate the problem; check the message details to resolve issues such as permission denied, invalid input, or resource not found.