TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node operation updates a single "Favorite" object in the connected service. It allows users to modify various attributes of an existing favorite item by specifying its unique identifier and providing new values for one or more fields. This is useful in scenarios where you want to reorganize, reassign, or update metadata related to favorites, such as changing its position, associating it with different entities (like workflows, notes, companies), or moving it to another folder.

Practical examples include:

  • Changing the order of favorites by updating their position.
  • Reassigning a favorite from one workflow or note to another.
  • Updating the folder where a favorite is stored.
  • Modifying which workspace member the favorite is associated with.

Properties

Name Meaning
Id The unique identifier of the favorite object to update. This is required.
Depth Determines how much nested related data to return in the response: 0 returns only the favorite's own data; 1 includes directly related objects; 2 includes related objects of those related objects.
View Id Identifier linking the favorite to a specific view.
Note Id Identifier linking the favorite to a specific note.
Workflow Run Id Identifier linking the favorite to a specific workflow run.
Task Id Identifier linking the favorite to a specific task.
Workflow Version Id Identifier linking the favorite to a specific version of a workflow.
Workflow Id Identifier linking the favorite to a specific workflow.
Opportunity Id Identifier linking the favorite to a specific opportunity.
Favorite Folder Id Identifier of the folder where the favorite is stored.
Company Id Identifier linking the favorite to a specific company.
Person Id Identifier linking the favorite to a specific person.
For Workspace Member Id Identifier linking the favorite to a specific workspace member.
Position Numeric value representing the favorite's position/order.

Output

The node outputs JSON data representing the updated favorite object. The structure includes the favorite's properties as updated, potentially including nested related objects depending on the Depth parameter. The output does not include binary data.

Dependencies

  • Requires an API key credential for authenticating requests to the external Twenty API service.
  • The node uses the base URL and headers configured via credentials.
  • No additional environment variables are explicitly required beyond standard API authentication.

Troubleshooting

  • Missing or invalid Id: Since the Id property is required, omitting it or providing an incorrect Id will cause errors. Ensure the Id corresponds to an existing favorite.
  • Invalid field values: Providing invalid identifiers for linked entities (e.g., non-existent workflowId) may result in API errors.
  • Permission issues: If the API key lacks permissions to update favorites, the request will fail.
  • Depth parameter misuse: Setting an unsupported depth value might cause unexpected responses or errors.
  • Network or authentication errors: Check API credentials and network connectivity if requests fail.

Links and References

Discussion