Overview
This node integrates with the SmartSuite API to update records within a specified table of a SmartSuite solution. It allows users to modify one or more fields of an existing record by specifying the record ID and the new values for the fields.
Common scenarios where this node is beneficial include:
- Automating updates to project management data stored in SmartSuite, such as changing task statuses or due dates.
- Synchronizing external data sources with SmartSuite records by updating fields based on changes elsewhere.
- Bulk updating records programmatically during workflows that require data corrections or enhancements.
Practical example:
- Updating the status and priority fields of a task record in a project management solution when certain conditions are met in another system.
Properties
| Name | Meaning |
|---|---|
| Solution | Select the SmartSuite solution where the target table resides. |
| Table | Select the specific table within the chosen solution that contains the record to update. |
| Record ID | The unique identifier of the record you want to update. |
| Fields to Update | One or more field-value pairs specifying which fields to update and their new values. |
The "Fields to Update" property supports multiple entries, each requiring:
- Field: The specific field in the table to update.
- Value: The new value to assign to that field.
Output
The node outputs JSON objects representing the result of the update operation. Each output item includes:
success: Boolean indicating if the update was successful.data: The updated record data returned from SmartSuite.operation: The performed operation, here always"update".resource: The resource type, here"record".solutionId: The ID of the SmartSuite solution used.tableId: The ID of the table where the record resides.
Example output JSON structure:
{
"success": true,
"data": {
/* Updated record details */
},
"operation": "update",
"resource": "record",
"solutionId": "your-solution-id",
"tableId": "your-table-id"
}
The node does not output binary data.
Dependencies
- Requires an active connection to the SmartSuite API via an API key credential configured in n8n.
- Needs access to the SmartSuite solution and table IDs.
- Relies on the SmartSuite API endpoints for records and tables.
Troubleshooting
Common Issues
- Invalid Record ID: If the provided record ID does not exist in the specified table, the API will return an error.
- Field Validation Errors: Attempting to update fields with invalid data types or unsupported values may cause failures.
- Permission Denied: Insufficient permissions on the SmartSuite API key can prevent updates.
- Missing Required Parameters: Omitting required properties like solution ID, table ID, or record ID will cause errors.
Error Messages and Resolutions
- "Record not found": Verify the record ID and ensure it exists in the selected table.
- "Invalid field value": Check that the field values conform to expected types and formats.
- Authentication errors: Confirm that the API key credential is valid and has necessary scopes.
- Network or timeout errors: Ensure network connectivity and SmartSuite service availability.
Using the node's "Continue On Fail" option can help handle errors gracefully in workflows.
Links and References
- SmartSuite API Documentation (general reference for API endpoints)
- n8n Documentation - Creating Custom Nodes
- SmartSuite Official Website