Actions252
- Api Keys Actions
- Attachments Actions
- Blocklists Actions
- Calendar Channel Event Associations Actions
- Find Many Calendar Channel Event Associations
- Create One Calendar Channel Event Association
- Create Many Calendar Channel Event Associations
- Find One Calendar Channel Event Association
- Delete One Calendar Channel Event Association
- Update One Calendar Channel Event Association
- Find Calendar Channel Event Association Duplicates
- Companies Actions
- Calendar Channels Actions
- Calendar Event Participants Actions
- Calendar Events Actions
- Connected Accounts Actions
- Favorite Folders Actions
- Favorites Actions
- Message Channel Message Associations Actions
- Find Many Message Channel Message Associations
- Create One Message Channel Message Association
- Create Many Message Channel Message Associations
- Find One Message Channel Message Association
- Delete One Message Channel Message Association
- Update One Message Channel Message Association
- Find Message Channel Message Association Duplicates
- Message Channels Actions
- Message Folders Actions
- View Fields Actions
- Message Participants Actions
- Messages Actions
- Message Threads Actions
- Notes Actions
- Note Targets Actions
- Opportunities Actions
- People Actions
- Tasks Actions
- Task Targets Actions
- Timeline Activities Actions
- View Filter Groups Actions
- View Filters Actions
- View Groups Actions
- Views Actions
- View Sorts Actions
- Webhooks Actions
- Workflow Automated Triggers Actions
- Workflow Runs Actions
- Workflows Actions
- Workflow Versions Actions
- Workspace Members Actions
Overview
This node operation allows you to create a new favorite item within the "Favorites" resource. It is useful for marking or bookmarking various entities such as views, notes, workflows, tasks, companies, persons, opportunities, and workflow runs as favorites in your system. This can help users quickly access frequently used or important items.
Practical examples include:
- Marking a specific workflow or task as a favorite for quick access.
- Adding a note or company to favorites to track important information.
- Organizing favorites by assigning them to favorite folders or specifying their position.
Properties
| Name | Meaning |
|---|---|
| Depth | Determines how much related nested data to include in the response: 0 (only primary object), 1 (primary + directly related objects), 2 (primary + related + related of related). |
| View Id | Identifier of a view to be marked as favorite. |
| Note Id | Identifier of a note to be marked as favorite. |
| Workflow Run Id | Identifier of a workflow run to be marked as favorite. |
| Task Id | Identifier of a task to be marked as favorite. |
| Workflow Version Id | Identifier of a specific version of a workflow to be marked as favorite. |
| Workflow Id | Identifier of a workflow to be marked as favorite. |
| Opportunity Id | Identifier of an opportunity to be marked as favorite. |
| Favorite Folder Id | Identifier of a folder where the favorite will be organized. |
| Company Id | Identifier of a company to be marked as favorite. |
| Person Id | Identifier of a person to be marked as favorite. |
| For Workspace Member Id | Identifier of the workspace member for whom the favorite is created. |
| Position | Numeric value indicating the position/order of the favorite item. |
Output
The output JSON contains the details of the newly created favorite item, including its identifiers and any related nested objects depending on the Depth parameter. The structure reflects the favorite's properties and relationships as returned by the API.
If binary data were involved (not indicated here), it would typically represent files or attachments related to the favorite, but this operation focuses on JSON data only.
Dependencies
- Requires an API key credential for authenticating with 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 Required Identifiers: If no valid identifier (e.g.,
viewId,noteId, etc.) is provided, the API may reject the request. Ensure at least one target entity ID is specified. - Invalid IDs: Providing incorrect or non-existent IDs will result in errors from the API. Verify that all IDs correspond to existing resources.
- Authentication Errors: Failure to provide valid API credentials will cause authorization errors. Confirm that the API key or token is correctly set up.
- Position Conflicts: Setting a position that conflicts with existing favorites might cause unexpected ordering; verify the position value if ordering is important.
- Depth Parameter Misuse: Using a depth level higher than supported by the API could lead to incomplete or failed responses.
Links and References
- Twenty API Documentation (hypothetical link for reference)
- n8n Documentation on Creating Custom Nodes