TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation updates a single "View Filter" object in the connected system via the Twenty API. It allows users to modify various attributes of an existing view filter, such as its position within a group, associated field metadata, operand, and display values. This is useful in scenarios where dynamic filtering criteria need to be adjusted programmatically, for example, updating dashboard filters or report parameters based on changing data conditions.

Practical examples include:

  • Adjusting a filter's value or operand to refine displayed data without manual intervention.
  • Reordering filters within a filter group to change their evaluation priority.
  • Changing the target field or subfield that the filter applies to.

Properties

Name Meaning
Id The unique identifier of the view filter object to update. This is required to specify which filter to modify.
Depth Determines how much related nested data to return with the response: 0 (only primary object), 1 (primary plus directly related objects), or 2 (primary plus related objects and their related objects).
View Filter Group Id Identifier of the group to which this view filter belongs.
View Id Identifier of the view that this filter is part of.
Sub Field Name Name of a subfield within the target field, if applicable.
Position In View Filter Group Numeric position of this filter within its filter group, affecting order or priority.
Display Value The human-readable display value for the filter, used in UI representations.
Value The actual value used by the filter for comparison or matching.
Operand The operand or operator used in the filter condition (e.g., equals, contains).
Field Metadata Id Identifier of the target field metadata that this filter applies to.

Output

The node outputs the updated view filter object in JSON format. The structure includes the updated properties of the view filter, potentially including nested related objects depending on the Depth parameter. This output can be used downstream in workflows to confirm changes or trigger further actions.

No binary data output is involved.

Dependencies

  • Requires connection to the Twenty API service.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL for the API is set from the credential domain configuration.

Troubleshooting

  • Missing or invalid Id: The update operation requires a valid view filter ID. Ensure the Id property is correctly set; otherwise, the API will reject the request.
  • Invalid field references: If Field Metadata Id, View Id, or View Filter Group Id are incorrect or do not exist, the update may fail or produce unexpected results.
  • Permission errors: Insufficient API permissions or expired tokens can cause authorization failures.
  • Incorrect operand or value types: Providing operands or values incompatible with the target field type may result in validation errors.
  • Network or API downtime: Connectivity issues or API service interruptions will prevent successful updates.

To resolve these issues:

  • Verify all IDs and references before running the node.
  • Check API credentials and renew tokens if necessary.
  • Validate operand and value formats according to the API documentation.
  • Monitor network connectivity and API status.

Links and References

Discussion