TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation updates a single "View" object in an external system via an API. It allows users to modify various attributes of a view, such as its name, type, position, display mode, and specific metadata related to Kanban board configurations. This is useful in scenarios where you want to programmatically adjust how data views are presented or organized within an application, for example updating a dashboard layout or changing the way records are aggregated and displayed in a Kanban board.

Practical examples include:

  • Changing the name or icon of a view to reflect new project requirements.
  • Adjusting the depth of nested related objects returned by the API to control response detail.
  • Modifying Kanban-specific settings like aggregate operations or field metadata to customize summary calculations on cards.
  • Switching between compact and expanded display modes or choosing whether records open in a side panel or full page.

Properties

Name Meaning
Id The unique identifier of the view object to update (required).
Depth Level of nested related objects included in the response: 0 = only primary object, 1 = primary + directly related objects, 2 = primary + related objects + their related objects.
Kanban Aggregate Operation Optional aggregate operation applied in Kanban views. Options: AVG, COUNT, MAX, MIN, SUM, COUNT EMPTY, COUNT NOT EMPTY, COUNT UNIQUE VALUES, PERCENTAGE EMPTY, PERCENTAGE NOT EMPTY, COUNT TRUE, COUNT FALSE.
Key View key identifier. Currently supports "INDEX".
Kanban Field Metadata Id Identifier for the Kanban column field metadata.
Position Numeric position/order of the view.
Is Compact Boolean indicating if the view is displayed in compact mode.
Open Record In Where to display records when opened: SIDE PANEL or RECORD PAGE.
Kanban Aggregate Operation Field Metadata Id Field metadata ID used for the aggregate operation in Kanban views.
Object Metadata Id Identifier of the target object metadata that this view represents.
Name Name of the view.
Type Type of the view (e.g., list, kanban, calendar).
Icon Icon associated with the view.

Output

The node outputs the updated view object in JSON format. This JSON contains the properties of the view after the update, reflecting any changes made through the input parameters. The structure corresponds to the view resource schema from the API, including fields like id, name, type, position, and any Kanban-specific metadata.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the external Twenty API.
  • The base URL for the API is configured via credentials.
  • The node uses standard HTTP headers for JSON content negotiation.
  • No additional external dependencies beyond the API service.

Troubleshooting

  • Missing or invalid Id: The update operation requires a valid view Id. Ensure the Id is correct and exists in the target system.
  • Invalid property values: Some properties have restricted options (e.g., Depth, Kanban Aggregate Operation). Providing unsupported values may cause errors.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Network or API errors: Check connectivity and API availability. Review error messages for rate limits or server issues.
  • Empty required fields: Required fields like Id must not be empty; otherwise, the API will reject the request.

Links and References

Discussion