SmartSuite icon

SmartSuite

Interact with SmartSuite API to manage records, search data, and perform operations on your SmartSuite solutions.

Actions9

Overview

This node integrates with the SmartSuite API to manage tables and their fields within a SmartSuite solution. Specifically, the Create Field operation under the Table resource allows users to add a new field to an existing table in a selected SmartSuite solution.

Typical use cases include:

  • Dynamically extending the schema of a SmartSuite table by adding custom fields such as text, number, date, or select options.
  • Automating the setup of tables with required fields during deployment or integration workflows.
  • Managing metadata and structure of SmartSuite tables programmatically without manual UI interaction.

For example, you might use this node to add a "Priority" single-select field with options like "High", "Medium", and "Low" to a project management table, enabling better task categorization.

Properties

Name Meaning
Solution Select the SmartSuite solution where the target table resides.
Table ID The ID of the specific table within the solution where the new field will be created.
Field Name The internal name identifier for the new field to create.
Field Label The user-friendly label for the new field that will appear in the SmartSuite UI.
Field Type The data type of the field to create. Options include: Text, Number, Checkbox, Date, Email, URL, Phone, Multi-Select, Single-Select, User, File, Reference.
Field Description Optional description providing additional context about the field's purpose.
Select Options (Only for Multi-Select or Single-Select field types) A collection of options defining the selectable values. Each option includes a label (display name) and an optional color (hex code).

Output

The node outputs JSON data structured as follows:

  • success: Boolean indicating if the operation was successful.
  • data: The response data from the SmartSuite API representing the updated table structure including the newly added field.
  • operation: The performed operation name (createField).
  • resource: The resource type (table).
  • solutionId: The ID of the SmartSuite solution used.
  • tableId: The ID of the table where the field was created.

If multiple items are returned, each is output as a separate JSON object in the array.

The node does not output binary data.

Dependencies

  • Requires a valid API key credential for authenticating with the SmartSuite API.
  • The node depends on the SmartSuite API endpoints for solutions, applications (tables), and records.
  • Proper configuration of the API credential in n8n is necessary.
  • The node uses internal helper functions to make HTTP requests to SmartSuite's REST API.

Troubleshooting

  • Common issues:

    • Invalid or missing Solution ID or Table ID can cause API errors.
    • Providing invalid field types or malformed select options may result in request failures.
    • Network connectivity or authentication failures with the SmartSuite API.

  • Error messages:

    • Errors returned from the API will be included in the output JSON under the error field if "Continue On Fail" is enabled.
    • Typical error messages include authorization errors, resource not found, or validation errors on field creation.

  • Resolutions:

    • Verify that the Solution and Table IDs are correct and accessible with the provided API credentials.
    • Ensure the field type matches one of the supported types.
    • For select fields, ensure at least one option with a label is provided.
    • Check network connectivity and API key validity.

Links and References

Discussion