TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node updates a single "View Group" object in the connected system via the Twenty API. It allows modifying various attributes of an existing View Group, such as its target field, position, visibility, and grouping criteria. This operation is useful when you want to programmatically adjust how data views are grouped or displayed without manually editing them in the UI.

Common scenarios:

  • Dynamically changing the grouping of data views based on user input or other workflow conditions.
  • Automating updates to view configurations during data processing pipelines.
  • Managing visibility and order of grouped fields in views for reporting or dashboard purposes.

Example:
You have a dashboard that groups data by a certain field. Using this node, you can update the group to change which field it groups by, reposition the group, or toggle its visibility automatically based on external triggers.

Properties

Name Meaning
Id The unique identifier of the View Group object to update. This is required to specify which View Group will be modified.
Depth Determines how much nested related data to include in the response after updating. Options: 0 (only primary object), 1 (primary + directly related objects), 2 (primary + related + related of related).
Field Metadata Id The ID of the target field metadata that this View Group should reference or be associated with.
View Id The ID of the view to which this View Group belongs.
Position Numeric position indicating the order of this View Group among others.
Field Value The value of the field by which to group data within this View Group.
Is Visible Boolean flag indicating whether this View Group should be visible or hidden in the view.

Output

The node outputs JSON data representing the updated View Group object. The structure includes the updated properties of the View Group, potentially including nested related objects depending on the Depth parameter.

If binary data were involved (not indicated here), it would typically represent files or media associated with the View Group, but this node focuses on JSON data only.

Dependencies

  • Requires an API key credential for authenticating with the Twenty API.
  • The node uses the base URL and headers configured from the provided credentials.
  • No additional external dependencies beyond the Twenty API service.

Troubleshooting

  • Missing or invalid Id: If the Id property is not provided or incorrect, the API call will fail because it cannot identify which View Group to update.
  • Invalid field IDs or values: Providing non-existent fieldMetadataId or viewId may cause errors or no changes.
  • Permission issues: Ensure the API key has sufficient permissions to update View Groups.
  • Network or authentication errors: Check API credentials and network connectivity if requests fail.
  • Depth parameter misuse: Setting an unsupported depth level might result in incomplete or unexpected response data.

Links and References

Discussion